snort3: inform user of optional dependencies

Add a comment to the package description to inform users that the build
system will not automatically pick gperftools-runtime and vectorscan-
runtime when building from source.

References to performance benefits of using them:
c1b4e80825d6855d66899dc32490b0ce9537aff5
b6b2d1e3059c049bf0af4330dfde944c1689be9f

Signed-off-by: John Audia <[email protected]>

diff --git a/net/snort3/Makefile b/net/snort3/Makefile
index eadad44e8831d1b0f6897bbfaccd3b396dbb9b8d..53b1f8279e4a118ee90d2b8626726c119810330c 100644 (file)
--- a/net/snort3/Makefile
+++ b/net/snort3/Makefile
@@ -41,6 +41,14 @@ define Package/snort3/description
   and packet logging on IP networks.  It utilizes a combination of protocol
   analysis and pattern matching in order to detect anomalies, misuse and
   attacks.
+
+  Note:
+    When compiling from source, and if your target supports them, optionally
+    enable runtime dependencies for improved performance:
+      - gperftools
+      - vectorscan
+    These are not enabled by default and must be manually selected in menuconfig
+    to take advantage of their benefits.
 endef
 
 CMAKE_OPTIONS += \